PUT domains/<domain>
Opis
Modyfikacja ustawień wybranej domeny pocztowej.
Sygnatura polecenia
- Metoda żądania - PUT
- Ścieżka żądania (URL PATH) - parametry identyfikujące domenę
- Ciało żądania - wszystkie lub wybrane parametry modyfikujące domenę pocztową
- Ciało odpowiedzi - wszystkie parametry opisujące domenę pocztową
Parametry ścieżki:
(string)
domain
wymagany Nazwa edytowanej domeny.
wymagany Nazwa edytowanej domeny.
przykładowa wartość:
demo.kei.pl
Parametry modyfikujące:
catchall_type
Określenie zasad działania konta domyślnego (tzw. catchall address) czyli konta pocztowego, gdzie będą trafiać wiadomości e-mail kierowane na nieistniejące konta.
dopuszczalne wartości:
- 0: Brak konta domyślnego. Wiadomości będą zwracane do nadawcy.
- 1: Istniejące konto w bieżącej domenie pocztowej.
- 2: Istniejące konto w innej domenie pocztowej
- 3: Inna domena pocztowa. Wiadomości kierowane na niestniejące konto abc@przykladowa-domena.pl będą kierowane na adres abc@wskazana-domena.pl. Funkcjonalność przydatna, gdy chcemy obsługiwać adresy pocztowe o tej samej nazwie w wielu domenach, bez konieczności ich tworzenia w każdej z nich
catchall_address
Pełen adres e-mail lub domena, w zależności od trybu działania konta domyślnego, służące jako jego adres.
spam_enabled
Obsługa filtrów antyspamowych na koncie pocztowym.
spam_white_list
Adresy e-mail lub domeny, które zawsze zostaną zaakceptowane przez system pocztowy.
wymagania składniowe:
- - Parametr musi mieć formę listy poprawnych adresów email lub domen
spam_black_list
Adresy e-mail lub domeny, które nigdy nie zostaną zaakceptowane przez system pocztowy.
wymagania składniowe:
- - Parametr musi mieć formę listy poprawnych adresów email lub domen
spam_greylist_whitelist
Adresy e-mail lub domeny, które zawsze zostaną zaakceptowane przez mechanizm Greylist.
wymagania składniowe:
- - Parametr musi mieć formę listy poprawnych adresów email lub domen
spam_spf_whitelist
Adresy e-mail lub domeny, które zawsze zostaną zaakceptowane przez mechanizm SPF.
wymagania składniowe:
- - Parametr musi mieć formę listy poprawnych adresów email lub domen
spam_rbl_whitelist
Adresy e-mail lub domeny, które zawsze zostaną zaakceptowane przez mechanizm RBL.
wymagania składniowe:
- - Parametr musi mieć formę listy poprawnych adresów email lub domen
spam_rbl_enabled
Mechanizm RBL (Real-time Blackhole List ) stale monitoruje i zbiera adresy IP serwerów, które są odpowiedzialne za rozsyłanie spamu do użytkowników poczty. Włączenie opcji pozwala zmniejszyć liczbę spamu.
dopuszczalne wartości:
- -1: domyślne
- 1: tak
- 0: nie
spam_spf_enabled
Mechanizm SPF zabezpiecza serwery SMTP przed przyjmowaniem poczty z niedozwolonych źródeł. Włączenie opcji pozwala ograniczyć wysyłanie wiadomości przez spamerów podszywających się pod cudze adresy e-mail.
dopuszczalne wartości:
- -1: domyślne
- 1: tak
- 0: nie
spam_greylist_enabled
Mechanizm GREYLIST odrzuca maile od nierozpoznanych nadawców przy pierwszej próbie ich dostarczenia, natomiast akceptuje je przy drugiej. Jeśli poczta pochodzi z serwera rozsyłającego spam, na ogół nie jest wysyłana ponownie.
dopuszczalne wartości:
- -1: domyślne
- 1: tak
- 0: nie
Parametry odpowiedzi:
spam_rbl_default
Aktywna wartość filtru antyspamowego rbl dla serwera. Obejmuje te konta/domeny pocztowe, które dla tego filtru mają ustawioną wartość domyślnie.
dopuszczalne wartości:
- 1: tak
- 0: nie
spam_spf_default
Aktywna wartość filtru antyspamowego spf dla serwera. Obejmuje te konta/domeny pocztowe, które dla tego filtru mają ustawioną wartość domyślnie.
dopuszczalne wartości:
- 1: tak
- 0: nie
spam_greylist_default
Aktywna wartość filtru antyspamowego greylist dla serwera. Obejmuje te konta/domeny pocztowe, które dla tego filtru mają ustawioną wartość domyślnie.
dopuszczalne wartości:
- 1: tak
- 0: nie
account_limit
Przyznany limit kont pocztowych. W zależności od konfiguracji usługi może obejmować domenę lub wszystkie domeny należące do konta.
alias_limit
Przyznany limit aliasów pocztowych. W zależności od konfiguracji usługi może obejmować domenę lub wszystkie domeny należące do konta.
mailinglist_limit
Przyznany limit list pocztowych. W zależności od konfiguracji usługi może obejmować domenę lub wszystkie domeny należące do konta.
capacity_limit
Przyznany limit zajętości. W zależności od konfiguracji usługi może obejmować domenę lub wszystkie domeny należące do konta.
account_limit_usage
Liczba kont utworzonych w ramach limitu. W zależności od konfiguracji usługi uwzględnia pojedynczą lub wszystkie wszystkie domeny należące do konta.
alias_limit_usage
Liczba aliasów utworzonych w ramach limitu. W zależności od konfiguracji usługi uwzględnia pojedynczą lub wszystkie wszystkie domeny należące do konta.
mailinglist_limit_usage
Liczba list utworzonych w ramach limitu. W zależności od konfiguracji usługi uwzględnia pojedynczą lub wszystkie wszystkie domeny należące do konta.
capacity_limit_usage
Suma limitów zajętości istniejących kont pocztowych. W zależności od konfiguracji usługi uwzględnia pojedynczą lub wszystkie wszystkie domeny należące do konta.
Przykładowe zapytanie:
PUT https://as27.demo.kei.pl/v1/domains/demo.kei.pl
parametry:{
"spam_enabled":1,
"spam_white_list":true,
"spam_black_list":true,
"spam_rbl_whitelist":[
"nowyadres@onet.pl",
"kolejnynowyadres@wp.pl"
]
}
Przykładowa odpowiedź:
{
"catchall_type":0,
"catchall_address":"",
"spam_enabled":1,
"spam_white_list":true,
"spam_black_list":true,
"spam_greylist_whitelist":[
],
"spam_spf_whitelist":[
],
"spam_rbl_whitelist":[
"nowyadres@onet.pl",
"kolejnynowyadres@wp.pl"
],
"spam_rbl_enabled":-1,
"spam_spf_enabled":-1,
"spam_greylist_enabled":-1,
"spam_rbl_default":"1",
"spam_spf_default":"1",
"spam_greylist_default":"1",
"account_limit":"-1",
"alias_limit":"1",
"mailinglist_limit":"-1",
"capacity_limit":"-1",
"account_limit_usage":"0",
"alias_limit_usage":"1",
"mailinglist_limit_usage":"1",
"capacity_limit_usage":"0"
}